home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmCommand.z / XmCommand
Encoding:
Text File  |  2002-10-03  |  34.1 KB  |  463 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCCoooommmmmmmmaaaannnndddd - The Command widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/Command.h>
  13.  
  14.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  15.           This page documents Motif 2.1.
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.           Command is a special-purpose composite widget for command
  19.           entry that provides a built-in command-history mechanism.
  20.           Command includes a command-line text-input field, a
  21.           command-line prompt, and a command-history list region.
  22.  
  23.           One additional WWWWoooorrrrkkkkAAAArrrreeeeaaaa child may be added to the Command
  24.           after creation.
  25.  
  26.           Whenever a command is entered, it is automatically added to
  27.           the end of the command-history list and made visible.  This
  28.           does not change the selected item in the list, if there is
  29.           one.
  30.  
  31.           Many of the new resources specified for Command are actually
  32.           SelectionBox resources that have been renamed for clarity
  33.           and ease of use.
  34.  
  35.         DDDDeeeesssscccceeeennnnddddaaaannnnttttssss
  36.           Command automatically creates the descendants shown in the
  37.           following table.  An application can use XXXXttttNNNNaaaammmmeeeeTTTTooooWWWWiiiiddddggggeeeetttt to
  38.           gain access to the named descendant. In addition, a user or
  39.           an application can use the named descendant when specifying
  40.           resource values.
  41.           NNNNaaaammmmeeeedddd DDDDeeeesssscccceeeennnnddddaaaannnntttt   CCCCllllaaaassssssss              IIIIddddeeeennnnttttiiiittttyyyy
  42.           ______________________________________________________________________________________________________________________________________
  43.           IIIItttteeeemmmmssssLLLLiiiisssstttt          XXXXmmmmLLLLiiiisssstttt             command-history list region
  44.           IIIItttteeeemmmmssssLLLLiiiissssttttSSSSWWWW        XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww   the ScrolledWindow parent of
  45.                                                 IIIItttteeeemmmmssssLLLLiiiisssstttt
  46.           SSSSeeeelllleeeeccccttttiiiioooonnnn          XXXXmmmmLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt      command-line prompt
  47.           TTTTeeeexxxxtttt               XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeelllldddd        command-line text-input field
  48.  
  49.         CCCCllllaaaasssssssseeeessss
  50.           Command inherits behavior, resources, and traits from CCCCoooorrrreeee,
  51.           CCCCoooommmmppppoooossssiiiitttteeee, CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr, XXXXmmmmBBBBuuuulllllllleeeettttiiiinnnnBBBBooooaaaarrrrdddd, and
  52.           XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnBBBBooooxxxx.
  53.  
  54.           The class pointer is _x_m_C_o_m_m_a_n_d_W_i_d_g_e_t_C_l_a_s_s.
  55.  
  56.           The class name is XXXXmmmmCCCCoooommmmmmmmaaaannnndddd.
  57.  
  58.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  59.           The following table defines a set of widget resources used
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           by the programmer to specify data. The programmer can also
  75.           set the resource values for the inherited classes to set
  76.           attributes for this widget. To reference a resource by name
  77.           or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  78.           prefix and use the remaining letters.  To specify one of the
  79.           defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  80.           the XXXXmmmm prefix and use the remaining letters (in either
  81.           lowercase or uppercase, but include any underscores between
  82.           words).  The codes in the access column indicate if the
  83.           given resource can be set at creation time (C), set by using
  84.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  85.           not applicable (N/A).
  86.  
  87.                                          XXXXmmmmCCCCoooommmmmmmmaaaannnndddd RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  88.           NNNNaaaammmmeeee                         CCCCllllaaaassssssss                 TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  89.           XmNcommand                   XmCTextString         XmString         ""        CSG
  90.           XmNcommandChangedCallback    XmCCallback           XtCallbackList   NULL      C
  91.           XmNcommandEnteredCallback    XmCCallback           XtCallbackList   NULL      C
  92.           XmNhistoryItems              XmCItems              XmStringTable    NULL      CSG
  93.           XmNhistoryItemCount          XmCItemCount          int              0         CSG
  94.           XmNhistoryMaxItems           XmCMaxItems           int              100       CSG
  95.           XmNhistoryVisibleItemCount   XmCVisibleItemCount   int              dynamic   CSG
  96.           XmNpromptString              XmCPromptString       XmString         dynamic   CSG
  97.  
  98.           XXXXmmmmNNNNccccoooommmmmmmmaaaannnndddd
  99.                     Contains the current command-line text. This is
  100.                     the XXXXmmmmNNNNtttteeeexxxxttttSSSSttttrrrriiiinnnnggggresource in SelectionBox, renamed
  101.                     for Command.  This resource can also be modified
  102.                     with XXXXmmmmCCCCoooommmmmmmmaaaannnnddddSSSSeeeettttVVVVaaaalllluuuueeee and XXXXmmmmCCCCoooommmmmmmmaaaannnnddddAAAAppppppppeeeennnnddddVVVVaaaalllluuuueeee
  103.                     functions.  The command area is a Text widget.
  104.  
  105.           XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  106.                     Specifies the list of callbacks that is called
  107.                     after each time the value of the command changes.
  108.                     The callback reason is XXXXmmmmCCCCRRRR____CCCCOOOOMMMMMMMMAAAANNNNDDDD____CCCCHHHHAAAANNNNGGGGEEEEDDDD.  This
  109.                     is equivalent to the XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk of
  110.                     the Text widget, except that a pointer to an
  111.                     _X_m_C_o_m_m_a_n_d_C_a_l_l_b_a_c_k_S_t_r_u_c_t_u_r_e is passed, and the
  112.                     structure's _v_a_l_u_e member contains the XXXXmmmmSSSSttttrrrriiiinnnngggg.
  113.  
  114.           XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddEEEEnnnntttteeeerrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  115.                     Specifies the list of callbacks that is called
  116.                     when a command is entered in the Command.  The
  117.                     callback reason is XXXXmmmmCCCCRRRR____CCCCOOOOMMMMMMMMAAAANNNNDDDD____EEEENNNNTTTTEEEERRRREEEEDDDD. A pointer
  118.                     to an _X_m_C_o_m_m_a_n_d_C_a_l_l_b_a_c_k structure is passed.
  119.  
  120.           XXXXmmmmNNNNhhhhiiiissssttttoooorrrryyyyIIIItttteeeemmmmssss
  121.                     Lists XXXXmmmmSSSSttttrrrriiiinnnngggg items that make up the contents of
  122.                     the history list. This is the XXXXmmmmNNNNlllliiiissssttttIIIItttteeeemmmmssss
  123.                     resource in SelectionBox, renamed for Command.
  124.                     XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss for this resource returns the list
  125.                     items themselves, not a copy of the list items.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     The application must not free the returned items.
  141.  
  142.           XXXXmmmmNNNNhhhhiiiissssttttoooorrrryyyyIIIItttteeeemmmmCCCCoooouuuunnnntttt
  143.                     Specifies the number of _X_m_S_t_r_i_n_g_s in
  144.                     XXXXmmmmNNNNhhhhiiiissssttttoooorrrryyyyIIIItttteeeemmmmssss. This is the XXXXmmmmNNNNlllliiiissssttttIIIItttteeeemmmmCCCCoooouuuunnnntttt
  145.                     resource in SelectionBox, renamed for Command.
  146.                     The value must not be negative.
  147.  
  148.           XXXXmmmmNNNNhhhhiiiissssttttoooorrrryyyyMMMMaaaaxxxxIIIItttteeeemmmmssss
  149.                     Specifies the maximum number of items allowed in
  150.                     the history list. Once this number is reached, an
  151.                     existing list item must be removed before a new
  152.                     item can be added to the list. For each command
  153.                     entered, the first list item is removed from the
  154.                     list, so the new command can be added to the list.
  155.                     The value must be greater than 0 (zero).
  156.  
  157.           XXXXmmmmNNNNhhhhiiiissssttttoooorrrryyyyVVVViiiissssiiiibbbblllleeeeIIIItttteeeemmmmCCCCoooouuuunnnntttt
  158.                     Specifies the number of items in the history list
  159.                     that should be visible at one time. In effect, it
  160.                     sets the height (in lines) of the history list
  161.                     window. This is the XXXXmmmmNNNNlllliiiissssttttVVVViiiissssiiiibbbblllleeeeIIIItttteeeemmmmCCCCoooouuuunnnntttt
  162.                     resource in SelectionBox, renamed for Command.
  163.                     The value must be greater than 0 (zero).  The
  164.                     default is dynamic based on the height of the
  165.                     list.
  166.  
  167.           XXXXmmmmNNNNpppprrrroooommmmppppttttSSSSttttrrrriiiinnnngggg
  168.                     Specifies a prompt for the command line.  This is
  169.                     the XXXXmmmmNNNNsssseeeelllleeeeccccttttiiiioooonnnnLLLLaaaabbbbeeeellllSSSSttttrrrriiiinnnnggggresource in
  170.                     SelectionBox, renamed for Command.  The default
  171.                     may vary depending on the value of the
  172.                     XXXXmmmmNNNNllllaaaayyyyoooouuuuttttDDDDiiiirrrreeeeccccttttiiiioooonnnnresource and the locale.  In the
  173.                     C locale the default is > (right angle bracket).
  174.  
  175.                     Now that some default localized label strings are
  176.                     provided through message catalogs for the children
  177.                     of composite widgets, the llllaaaabbbbeeeellllSSSSttttrrrriiiinnnngggg resources
  178.                     cannot be set on the child through default
  179.                     resource files.  Instead, the resource provided at
  180.                     the parent level must be used.
  181.  
  182.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  183.           Command inherits behavior and resources from the
  184.           superclasses described in the following tables.  For a
  185.           complete description of each resource, refer to the
  186.           reference page for that superclass.
  187.  
  188.                                                XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnBBBBooooxxxx RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  189.           NNNNaaaammmmeeee                      CCCCllllaaaassssssss                     TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                   AAAAcccccccceeeessssssss
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           XmNapplyCallback          XmCCallback               XtCallbackList   NULL                      N/A
  207.           XmNapplyLabelString       XmCApplyLabelString       XmString         dynamic                   N/A
  208.           XmNcancelCallback         XmCCallback               XtCallbackList   NULL                      N/A
  209.           XmNcancelLabelString      XmCCancelLabelString      XmString         dynamic                   N/A
  210.           XmNchildPlacement         XmCChildPlacement         unsigned char    XmPLACE_ABOVE_SELECTION   CSG
  211.           XmNdialogType             XmCDialogType             unsigned char    XmDIALOG_COMMAND          G
  212.           XmNhelpLabelString        XmCHelpLabelString        XmString         dynamic                   N/A
  213.           XmNlistItemCount          XmCItemCount              int              0                         CSG
  214.           XmNlistItems              XmCItems                  XmStringTable    NULL                      CSG
  215.           XmNlistLabelString        XmCListLabelString        XmString         NULL                      N/A
  216.           XmNlistVisibleItemCount   XmCVisibleItemCount       int              dynamic                   CSG
  217.           XmNminimizeButtons        XmCMinimizeButtons        Boolean          False                     N/A
  218.           XmNmustMatch              XmCMustMatch              Boolean          False                     N/A
  219.           XmNnoMatchCallback        XmCCallback               XtCallbackList   NULL                      N/A
  220.           XmNokCallback             XmCCallback               XtCallbackList   NULL                      N/A
  221.           XmNokLabelString          XmCOkLabelString          XmString         dynamic                   N/A
  222.           XmNselectionLabelString   XmCSelectionLabelString   XmString         dynamic                   CSG
  223.           XmNtextAccelerators       XmCTextAccelerators       XtAccelerators   default                   C
  224.           XmNtextColumns            XmCColumns                short            dynamic                   CSG
  225.           XmNtextString             XmCTextString             XmString         ""                        CSG
  226.  
  227.                                       XXXXmmmmBBBBuuuulllllllleeeettttiiiinnnnBBBBooooaaaarrrrdddd RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  228.           NNNNaaaammmmeeee                   CCCCllllaaaassssssss                  TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt         AAAAcccccccceeeessssssss
  229.           XmNallowOverlap        XmCAllowOverlap        Boolean          True            CSG
  230.           XmNautoUnmanage        XmCAutoUnmanage        Boolean          False           N/A
  231.           XmNbuttonFontList      XmCButtonFontList      XmFontList       dynamic         N/A
  232.           XmNbuttonRenderTable   XmCButtonRenderTable   XmRenderTable    dynamic         CSG
  233.           XmNcancelButton        XmCWidget              Widget           NULL            N/A
  234.           XmNdefaultButton       XmCWidget              Widget           NULL            N/A
  235.           XmNdefaultPosition     XmCDefaultPosition     Boolean          False           CSG
  236.           XmNdialogStyle         XmCDialogStyle         unsigned char    dynamic         CSG
  237.           XmNdialogTitle         XmCDialogTitle         XmString         NULL            CSG
  238.           XmNfocusCallback       XmCCallback            XtCallbackList   NULL            C
  239.           XmNlabelFontList       XmCLabelFontList       XmFontList       dynamic         CSG
  240.           XmNlabelRenderTable    XmCLabelRenderTable    XmRenderTable    dynamic         CSG
  241.           XmNmapCallback         XmCCallback            XtCallbackList   NULL            C
  242.           XmNmarginHeight        XmCMarginHeight        Dimension        10              CSG
  243.           XmNmarginWidth         XmCMarginWidth         Dimension        10              CSG
  244.           XmNnoResize            XmCNoResize            Boolean          False           CSG
  245.           XmNresizePolicy        XmCResizePolicy        unsigned char    XmRESIZE_NONE   CSG
  246.           XmNshadowType          XmCShadowType          unsigned char    XmSHADOW_OUT    CSG
  247.           XmNtextFontList        XmCTextFontList        XmFontList       dynamic         CSG
  248.           XmNtextRenderTable     XmCTextRenderTable     XmRenderTable    dynamic         CSG
  249.           XmNtextTranslations    XmCTranslations        XtTranslations   NULL            C
  250.           XmNunmapCallback       XmCCallback            XtCallbackList   NULL            C
  251.  
  252.                                                 XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  253.           NNNNaaaammmmeeee                      CCCCllllaaaassssssss                   TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  254.           XmNbottomShadowColor      XmCBottomShadowColor    Pixel               dynamic                CSG
  255.           XmNbottomShadowPixmap     XmCBottomShadowPixmap   Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))
  269.  
  270.  
  271.  
  272.           XmNforeground             XmCForeground           Pixel               dynamic                CSG
  273.           XmNhelpCallback           XmCCallback             XtCallbackList      NULL                   C
  274.           XmNhighlightColor         XmCHighlightColor       Pixel               dynamic                CSG
  275.           XmNhighlightPixmap        XmCHighlightPixmap      Pixmap              dynamic                CSG
  276.           XmNinitialFocus           XmCInitialFocus         Widget              dynamic                CSG
  277.           XmNlayoutDirection        XmCLayoutDirection      XmDirection         dynamic                CG
  278.           XmNnavigationType         XmCNavigationType       XmNavigationType    XmTAB_GROUP            CSG
  279.           XmNpopupHandlerCallback   XmCCallback             XtCallbackList      NULL                   C
  280.           XmNshadowThickness        XmCShadowThickness      Dimension           dynamic                CSG
  281.           XmNstringDirection        XmCStringDirection      XmStringDirection   dynamic                CG
  282.           XmNtopShadowColor         XmCTopShadowColor       Pixel               dynamic                CSG
  283.           XmNtopShadowPixmap        XmCTopShadowPixmap      Pixmap              dynamic                CSG
  284.           XmNtraversalOn            XmCTraversalOn          Boolean             True                   CSG
  285.           XmNunitType               XmCUnitType             unsigned char       dynamic                CSG
  286.           XmNuserData               XmCUserData             XtPointer           NULL                   CSG
  287.  
  288.                                   CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  289.           NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  290.           XmNchildren         XmCReadOnly         WidgetList    NULL      G
  291.           XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  292.           XmNnumChildren      XmCReadOnly         Cardinal      0         G
  293.  
  294.                                                         CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  295.           NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  296.           XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                N/A
  297.           XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  298.           XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  299.           XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  300.           XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  301.           XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  302.           XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  303.           XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  304.           XmNdepth                        XmCDepth                        int              dynamic                CG
  305.           XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  306.           XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  307.           XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  308.           XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  309.           XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  310.           XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  311.           XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  312.           XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  313.           XmNx                            XmCPosition                     Position         0                      CSG
  314.           XmNy                            XmCPosition                     Position         0                      CSG
  315.  
  316.         CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
  317.           A pointer to the following structure is passed to each
  318.           callback:
  319.  
  320.           typedef struct
  321.           {
  322.                   int _r_e_a_s_o_n;
  323.                   XEvent * _e_v_e_n_t;
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 10/3/02)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))
  335.  
  336.  
  337.  
  338.                   XmString _v_a_l_u_e;
  339.                   int _l_e_n_g_t_h;
  340.           } XmCommandCallbackStruct;
  341.  
  342.           _r_e_a_s_o_n    Indicates why the callback was invoked
  343.  
  344.           _e_v_e_n_t     Points to the _X_E_v_e_n_t that triggered the callback
  345.  
  346.           _v_a_l_u_e     Specifies the XXXXmmmmSSSSttttrrrriiiinnnngggg in the CommandArea
  347.  
  348.           _l_e_n_g_t_h    Specifies the size in bytes of the XXXXmmmmSSSSttttrrrriiiinnnngggg value.
  349.                     This member is obsolete and exists for
  350.                     compatibility with earlier releases.
  351.  
  352.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  353.           XXXXmmmmCCCCoooommmmmmmmaaaannnndddd inherits translations from XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnBBBBooooxxxx.
  354.  
  355.         AAAAcccccccceeeelllleeeerrrraaaattttoooorrrrssss
  356.           The XXXXmmmmNNNNtttteeeexxxxttttAAAAcccccccceeeelllleeeerrrraaaattttoooorrrrssss from XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnBBBBooooxxxx are added to the
  357.           Text descendant of XXXXmmmmCCCCoooommmmmmmmaaaannnndddd.
  358.  
  359.         AAAAccccttttiiiioooonnnn RRRRoooouuuuttttiiiinnnneeeessss
  360.           The XXXXmmmmCCCCoooommmmmmmmaaaannnndddd action routines are:
  361.  
  362.           SelectionBoxUpOrDown(_P_r_e_v_i_o_u_s|_N_e_x_t|_F_i_r_s_t|_L_a_s_t):
  363.                     When called with an argument of PPPPrrrreeeevvvviiiioooouuuussss, or 0
  364.                     (zero) for compatibility, selects the previous
  365.                     item in the history list and replaces the text
  366.                     with that item.
  367.  
  368.                     When called with an argument of NNNNeeeexxxxtttt, or 1 for
  369.                     compatibility, selects the next item in the
  370.                     history list and replaces the text with that item.
  371.  
  372.                     When called with an argument of FFFFiiiirrrrsssstttt, or 2 for
  373.                     compatibility, selects the first item in the
  374.                     history list and replaces the text with that item.
  375.  
  376.                     When called with an argument of LLLLaaaasssstttt, or 3 for
  377.                     compatibility, selects the last item in the
  378.                     history list and replaces the text with that item.
  379.  
  380.                     Calls the callbacks for XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk.
  381.  
  382.         AAAAddddddddiiiittttiiiioooonnnnaaaallll BBBBeeeehhhhaaaavvvviiiioooorrrr
  383.           The Command widget has the following additional behavior:
  384.  
  385.           <<<<KKKKeeeeyyyy>>>><<<<oooossssffffCCCCaaaannnncccceeeellll>>>>:
  386.                     If the parent of the Command is a manager, the
  387.                     event is passed to the parent.
  388.  
  389.           <<<<KKKKeeeeyyyy>>>><<<<oooossssffffAAAAccccttttiiiivvvvaaaatttteeee>>>> in Text:
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 10/3/02)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmCCCCoooommmmmmmmaaaannnndddd((((3333XXXX))))
  401.  
  402.  
  403.  
  404.                     Calls the Text widget's XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk
  405.                     callbacks.  If the text is empty, this action then
  406.                     returns.  Otherwise, if the history list has
  407.                     XXXXmmmmNNNNhhhhiiiissssttttoooorrrryyyyMMMMaaaaxxxxIIIItttteeeemmmmssss items, it removes the first
  408.                     item in the list.  It adds the text to the history
  409.                     list as the last item, clears the text, and calls
  410.                     the XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddEEEEnnnntttteeeerrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  411.  
  412.           <<<<KKKKeeeeyyyy>>>> in Text:
  413.                     When any change is made to the text edit widget,
  414.                     this action calls the callbacks for
  415.                     XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk.
  416.  
  417.           <<<<BBBBttttnnnnDDDDoooowwwwnnnn>>>>((((2222++++)))) or <<<<KKKKeeeeyyyy>>>><<<<oooossssffffAAAAccccttttiiiivvvvaaaatttteeee>>>> in List:
  418.                     Calls the List widget's XXXXmmmmNNNNddddeeeeffffaaaauuuullllttttAAAAccccttttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk
  419.                     callbacks.  If the history list has
  420.                     XXXXmmmmNNNNhhhhiiiissssttttoooorrrryyyyMMMMaaaaxxxxIIIItttteeeemmmmssss items, this action removes the
  421.                     first item in the list.  It adds the selected List
  422.                     item to the history list as the last item, clears
  423.                     the text, and calls the
  424.                     XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddEEEEnnnntttteeeerrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkkcallbacks.
  425.  
  426.           <<<<FFFFooooccccuuuussssIIIInnnn>>>>:
  427.                     Calls the callbacks for XXXXmmmmNNNNffffooooccccuuuussssCCCCaaaallllllllbbbbaaaacccckkkk.
  428.  
  429.           <<<<MMMMaaaappppWWWWiiiinnnnddddoooowwww>>>>:
  430.                     When a Command that is the child of a DialogShell
  431.                     is mapped, this action calls the callbacks for
  432.                     XXXXmmmmNNNNmmmmaaaappppCCCCaaaallllllllbbbbaaaacccckkkk.
  433.  
  434.           <<<<UUUUnnnnmmmmaaaappppWWWWiiiinnnnddddoooowwww>>>>:
  435.                     When a Command that is the child of a DialogShell
  436.                     is unmapped, this action calls the callbacks for
  437.                     XXXXmmmmNNNNuuuunnnnmmmmaaaappppCCCCaaaallllllllbbbbaaaacccckkkk.
  438.  
  439.         VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss
  440.           The bindings for virtual keys are vendor specific.  For
  441.           information about bindings for virtual buttons and keys, see
  442.           VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss(3).
  443.  
  444.      RRRREEEELLLLAAAATTTTEEEEDDDD
  445.           CCCCoooommmmppppoooossssiiiitttteeee(3), CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt(3), CCCCoooorrrreeee(3), XXXXmmmmBBBBuuuulllllllleeeettttiiiinnnnBBBBooooaaaarrrrdddd(3),
  446.           XXXXmmmmCCCCoooommmmmmmmaaaannnnddddAAAAppppppppeeeennnnddddVVVVaaaalllluuuueeee(3), XXXXmmmmCCCCoooommmmmmmmaaaannnnddddEEEErrrrrrrroooorrrr(3),
  447.           XXXXmmmmCCCCoooommmmmmmmaaaannnnddddGGGGeeeettttCCCChhhhiiiilllldddd(3), XXXXmmmmCCCCoooommmmmmmmaaaannnnddddSSSSeeeettttVVVVaaaalllluuuueeee(3),
  448.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeCCCCoooommmmmmmmaaaannnndddd(3), XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr(3), and XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnBBBBooooxxxx(3).
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.      Page 7                                          (printed 10/3/02)
  460.  
  461.  
  462.  
  463.